License Management

The /license URL provides the ability to view and modify the device license key.

URL

/api/v1/license

HTTP Method

GET, PUT

Request Content Types

PUT command may use one of the following content types:

■

application/json – see description of Supported Parameters below

■

form/multi-part – supported for all configurations; may include multiple license keys and the device will apply the relevant key based on the corresponding serial number. In an HA configuration, the license may be applied to both the active and redundant devices.

Supported Request JSON Attributes

Attribute	Type	Description
licenseVersion	Number	License version. Currently, only version 1 ("1") is supported.
serialNumber	String	Serial number (of Active device for HA systems). If specified – compared to the device’s serial number and if a mismatch is found, the update request is rejected. This attribute is optional.
serialNumberRedundant	String	Serial number of Redundant device for HA systems only.
key	String	License key (of Active device for HA systems) in encrypted format.
keyRedundant	String	License key in encrypted format of Redundant device for HA systems only.
keyDescription	String	Description of the License Key such as device type.
keyDescriptionRedundant	String	Description of the License Key of the Redundant device for HA systems only.
macAddress	String	MAC address (of Active device for HA systems).
macAddressRedundant	String	MAC address of Redundant device for HA systems only.

HTTP Responses

■

200 OK

■

400 Bad request - provided license key is incorrect.

■

409 Conflict – license key can’t be loaded due to the current device state (e.g. application/json Content-Type is used for HA device).